'\" t
.TH cm2_info 1 "31 May 2013" "Code Manager II"

.SH NAME
cm2 info \- Get version/release control information

.SH SYNOPSIS
.TS
l l.
cm2 info	[\fB--verbose\fP] [\fB-s\fP] [\fB--long\fP] [\fB--versions\fP \fIA[,..]\fP] [\fB--xml\fP] file ...
.TE

.SH DESCRIPTION
The \fPcm2 info(1)\fP utility is used to report on version control and release control 
information for one or more files. When given a file and no other arguments the output will
appear similar to the following.

.TS
l.
filename:
0195f904893e9537f740e99eec92afb925fc02e8 [1] []            Original
8f8c55fab6aac95c2278a33c3dd26ccbd878cea2 [1] [0.0.3,0.0.4] Added umask setting
.TE

Hence the output shows the digital signature each version, (oldest version first),
and then in the brakets are the three most recent tags which contain that version.
Finally the message entered when that version was checked in is given.

For larger projects using RCS-based backends the utility may take some time to run.
The following command line options can be used to modify the generated output.

.SH ARGUMENTS
.TP 8
.B --verbose
Show more information regarding the process of retrieving the necessary information.
.TP
.B -s
Shorten SHA1 values to the first 10 bytes - which is typically more than enough to ensure
unique references in the versioning output.
.TP
.B --long
The output generated is modified to include the developer that checked in the file, 
the date the file was checked in and \fBALL\fP tags that contain this version.
.TP
.B --versions
This is passed one or more versions which can be used to limit the output to the
specified versions. The format of the versions allowed is described below.
.TP
.B --xml
General a simple XML file of the available information rather than a human-readable
column-based output.
.TP

.SH VERSION SPECIFICATION
If a version needs to be specified it can be done so in a number
of ways including:

.TP 4
.B * Local version numbers
The local version number can be specified directly or 
following the 'LOCAL:' designation. For example all of the below
are local version [depending on the back-end repository type]:

.TS
l.
1
1.21
121
LOCAL:1.2
LOCAL:434
.TE

.TP
.B * SHA1 digital signature
This should be the complete SHA1 reference either directly 
or following the 'SHA1:' designation. Hence the following two
examples are identical:

.TS
l.
7c91fd774dd742ea7921da3cd32f1ecb898ccd89
SHA1:7c91fd774dd742ea7921da3cd32f1ecb898ccd89
.TE

.TP
.B * Tag Reference
To get a version of a file for a specified tag the format
on the command line should be:

.TS
l.
TAG:nameoftag
.TE

.SH EXIT CODES
The \fIcm2 info(1)\fP follows UNIX standard practise:

.TP 4
.B 0
All information for one or more files was retrieved successfully.
.TP
.B >0
An error occurred whilst attempting to return the requested information.

.SH NOTES

It should be noted that the digital signature of each version retrieved does not
have to be unique. For example if a file 'X' had versions 'X1' and was currently at
\'X2' then if the developer checked out the file using the \fB--version\fP output to
retrieve 'X1', and then check it back in then the signatures listed for the versions would
be 'X1','X2' and then 'X1' again.

.SH AUTHOR
The \fBCode Manager II\fP tool set was written by Simon Edwards, Proprius Consulting Ltd, (\fBwww.proprius.co.uk\fP).

.SH SEE ALSO
.BR cm2_cmpprojects(1),
.BR cm2_cmpreleases(1),
.BR cm2_cpproject(1),
.BR cm2_listreleases(1),
.BR cm2_rollback(1),
.BR cm2_tagremove(1).

.SH AVAILABILITY
This utility was specifically written under the GNU GPL license and as required
by such software comes with \fIno warranty or guarantee of any kind\fP.

